/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.purl.sword.atom;

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import nu.xom.Attribute;
import nu.xom.Element;
import org.apache.logging.log4j.Logger;
import org.purl.sword.base.Namespaces;
import org.purl.sword.base.SwordElementInterface;
import org.purl.sword.base.SwordValidationInfo;
import org.purl.sword.base.SwordValidationInfoType;
import org.purl.sword.base.UnmarshallException;
import org.purl.sword.base.XmlElement;
import org.purl.sword.base.XmlName;

/**
 * Represents a text construct in the ATOM elements. This is a superclass of
 * several elements within this implementation.
 *
 * @author Neil Taylor
 */
public class TextConstruct extends XmlElement
    implements SwordElementInterface {
    /**
     * The content in the element.
     */
    private String content;

    /**
     * The type of the element.
     */
    private ContentType type;

    /**
     * The log.
     */
    private static Logger log = org.apache.logging.log4j.LogManager.getLogger(TextConstruct.class);

    /**
     * label for the type attribute.
     */
    public static final String ATTRIBUTE_TYPE = "type";

    /**
     * Create a new instance, specifying the prefix and local name.
     *
     * @param prefix The prefix.
     * @param name   The local name.
     */
    public TextConstruct(String prefix, String name) {
        this(prefix, name, Namespaces.NS_ATOM);
    }

    /**
     * Create a new instance. Set the default type to TextConstructType.TEXT.
     *
     * @param name The name that will be applied.
     */
    public TextConstruct(String name) {
        this(Namespaces.PREFIX_ATOM, name);
    }

    /**
     * Create a new instance. Set the XML name for the element.
     *
     * @param name The name to set.
     */
    public TextConstruct(XmlName name) {
        super(name);
    }

    /**
     * @param prefix       The prefix.
     * @param name         The local name.
     * @param namespaceUri The namespace URI.
     */
    public TextConstruct(String prefix, String name, String namespaceUri) {
        super(prefix, name, namespaceUri);
        initialise();
    }

    /**
     *
     */
    protected final void initialise() {
        this.type = ContentType.TEXT;
        this.content = null;
    }

    /**
     * Marshal the data in this object to an Element object.
     *
     * @return The data expressed in an Element.
     */
    public Element marshall() {
        Element element = new Element(getQualifiedName(), Namespaces.NS_ATOM);
        if (type != null) {
            Attribute typeAttribute = new Attribute(ATTRIBUTE_TYPE, type.toString());
            element.addAttribute(typeAttribute);
        }

        if (content != null) {
            element.appendChild(content);
        }
        return element;
    }

    /**
     * Unmarshal the text element into this object.
     *
     * This unmarshaller only handles plain text content, although it can
     * recognise the three different type elements of text, html and xhtml. This
     * is an area that can be improved in a future implementation, if necessary.
     *
     * @param text The text element.
     * @throws UnmarshallException If the specified element is not of
     *                             the correct type, where the localname is used
     *                             to specify the valid name. Also thrown
     *                             if there is an issue accessing the data.
     */
    public void unmarshall(Element text)
        throws UnmarshallException {
        unmarshall(text, null);
    }

    /**
     * @param text                 The text element.
     * @param validationProperties FIXME: PLEASE DOCUMENT.
     * @return SWORD validation info
     * @throws UnmarshallException If the specified element is not of
     *                             the correct type, where the localname is used
     *                             to specify the valid name. Also thrown
     *                             if there is an issue accessing the data.
     */
    public SwordValidationInfo unmarshall(Element text, Properties validationProperties)
        throws UnmarshallException {
        if (!isInstanceOf(text, xmlName)) {
            return handleIncorrectElement(text, validationProperties);
        }

        ArrayList<SwordValidationInfo> validationItems = new ArrayList<SwordValidationInfo>();
        ArrayList<SwordValidationInfo> attributeItems = new ArrayList<SwordValidationInfo>();

        try {
            initialise();

            // get the attributes
            int attributeCount = text.getAttributeCount();
            Attribute attribute = null;
            for (int i = 0; i < attributeCount; i++) {
                attribute = text.getAttribute(i);
                if (ATTRIBUTE_TYPE.equals(attribute.getQualifiedName())) {
                    boolean success = true;
                    String value = attribute.getValue();
                    if (ContentType.TEXT.toString().equals(value)) {
                        type = ContentType.TEXT;
                    } else if (ContentType.HTML.toString().equals(value)) {
                        type = ContentType.HTML;
                    } else if (ContentType.XHTML.toString().equals(value)) {
                        type = ContentType.XHTML;
                    } else {
                        log.error("Unable to parse extract type in " + getQualifiedName());
                        SwordValidationInfo info = new SwordValidationInfo(xmlName,
                                                                           new XmlName(attribute),
                                                                           "Invalid content type has been specified",
                                                                           SwordValidationInfoType.ERROR);
                        info.setContentDescription(value);
                        attributeItems.add(info);
                        success = false;
                    }

                    if (success) {
                        SwordValidationInfo info = new SwordValidationInfo(xmlName, new XmlName(attribute));
                        info.setContentDescription(type.toString());
                        attributeItems.add(info);
                    }
                } else {
                    SwordValidationInfo info = new SwordValidationInfo(xmlName,
                                                                       new XmlName(attribute),
                                                                       SwordValidationInfo.UNKNOWN_ATTRIBUTE,
                                                                       SwordValidationInfoType.INFO);
                    info.setContentDescription(attribute.getValue());
                    attributeItems.add(info);
                }
            }

            // retrieve all of the sub-elements
            int length = text.getChildCount();
            if (length > 0) {
                content = unmarshallString(text);
            }

        } catch (Exception ex) {
            log.error("Unable to parse an element in " + getQualifiedName() + ": " + ex.getMessage());
            throw new UnmarshallException("Unable to parse an element in " + getQualifiedName(), ex);
        }

        SwordValidationInfo result = null;
        if (validationProperties != null) {
            result = validate(validationItems, attributeItems, validationProperties);
        }
        return result;
    }

    public SwordValidationInfo validate(Properties validationContext) {
        return validate(null, null, validationContext);
    }

    /**
     * @param existing          add results to this.
     * @param attributeItems    add these too.
     * @param validationContext FIXME: PLEASE DOCUMENT.
     * @return SWORD validation info
     */
    protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
                                           List<SwordValidationInfo> attributeItems,
                                           Properties validationContext) {
        boolean validateAll = (existing == null);

        SwordValidationInfo result = new SwordValidationInfo(xmlName);
        result.setContentDescription(content);

        // item specific rules
        if (content == null) {
            result.addValidationInfo(
                new SwordValidationInfo(xmlName, "Missing content for element",
                                        SwordValidationInfoType.WARNING));
        }

        if (validateAll) {
            SwordValidationInfo info = new SwordValidationInfo(xmlName,
                                                               new XmlName(xmlName.getPrefix(), ATTRIBUTE_TYPE,
                                                                           xmlName.getNamespace()));
            info.setContentDescription(type.toString());
            result.addAttributeValidationInfo(info);
        }

        result.addUnmarshallValidationInfo(existing, attributeItems);
        return result;
    }


    /**
     * Get the content in this TextConstruct.
     *
     * @return The content, expressed as a string.
     */
    public String getContent() {
        return content;
    }

    /**
     * Set the content. This only supports text content.
     *
     * @param content The content.
     */
    public void setContent(String content) {
        this.content = content;
    }

    /**
     * Get the type.
     *
     * @return The type.
     */
    public ContentType getType() {
        return type;
    }

    /**
     * Set the type.
     *
     * @param type The type.
     */
    public void setType(ContentType type) {
        this.type = type;
    }

    /**
     * Get a string representation.
     *
     * @return The string.
     */
    public String toString() {
        return "Summary - content: " + getContent() + " type: " + getType();
    }
}
